| Package | dk.ehealth.sundhed.fhir.ig.core |
| Resource Type | OperationDefinition |
| Id | DocumentReference-t-deprecate-document |
| FHIR Version | R4 |
| Source | http://ehealth.sundhed.dk/fhir/https://build.fhir.org/ig/fut-infrastructure/implementation-guide/OperationDefinition-DocumentReference-t-deprecate-document.html |
| URL | http://ehealth.sundhed.dk/fhir/OperationDefinition/DocumentReference-t-deprecate-document |
| Version | 5.0.1 |
| Status | active |
| Date | 2025-08-12T12:42:26+00:00 |
| Name | deprecate-document |
| Title | Deprecate document |
| Realm | dk |
| Description | Deprecates a shared document. The operation takes a documentIdentifier and cpr-number as parameters and finds the DocumentReference with the corresponding masterIdentifier. masterIdentifier should be unique for DocumentReference so if less than 0 or more than 1 are found the operation throws and exception. If the found documentReference has a patient which cpr number matches the provided value the document is deprecated. iti-57 is used to deprecate the document on XDS. On successthe documentReference status is updated to superseded and updated in the database. |
| Type | true |
| Kind | operation |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: Operationsdefinition DocumentReference-t-deprecate-document
URL: [base]/DocumentReference/$deprecate-document
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | documentId | 0..1 | string (token) | |||
| IN | cpr | 0..1 | string (string) |
{
"resourceType": "OperationDefinition",
"id": "DocumentReference-t-deprecate-document",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "http://ehealth.sundhed.dk/fhir/OperationDefinition/DocumentReference-t-deprecate-document",
"version": "5.0.1",
"name": "deprecate-document",
"title": "Deprecate document",
"status": "active",
"kind": "operation",
"date": "2025-08-12T12:42:26+00:00",
"publisher": "Den telemedicinske infrastruktur (eHealth Infrastructure)",
"contact": [
{
"name": "Den telemedicinske infrastruktur (eHealth Infrastructure)",
"telecom": [
{
"system": "url",
"value": "http://ehealth.sundhed.dk"
}
]
}
],
"description": "Deprecates a shared document. The operation takes a documentIdentifier and cpr-number as parameters and finds the DocumentReference with the corresponding masterIdentifier. masterIdentifier should be unique for DocumentReference so if less than 0 or more than 1 are found the operation throws and exception. If the found documentReference has a patient which cpr number matches the provided value the document is deprecated. iti-57 is used to deprecate the document on XDS. On successthe documentReference status is updated to superseded and updated in the database.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "DK",
"display": "Denmark"
}
]
}
],
"affectsState": true,
"code": "deprecate-document",
"resource": [
"DocumentReference"
],
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "documentId",
"use": "in",
"min": 0,
"max": "1",
"type": "string",
"searchType": "token"
},
{
"name": "cpr",
"use": "in",
"min": 0,
"max": "1",
"type": "string",
"searchType": "string"
}
]
}